METERS
 

Each meter needs to have an unique name, which defines a section in the ini-file for that meter. The name needs to be put inside []-characters. The name doesn't matter as long as you don't use it anywhere else in the same ini-file. Do not use spaces in the names.

General settings for all meters

MeasureName
The name of the measure that this meter displays.

X
The X-position of the meter inside the window. The coordinates can be made relative to the previous meter by adding 'r' to the end of the number (e.g. X=5r). You can also use capital R which makes the position relative to the right edge of the previous meter.

Y
The Y-position of the meter inside the window. The coordinates can be made relative to the previous meter by adding 'r' to the end of the number (e.g. Y=-10r). You can also use capital R which makes the position relative to the bottom edge of the previous meter.

W
The width of the meter. It is not necessary to define this if the width can be calculated from an image or if you are using a STRING meter. If you use the desktop as background for the Rainmeter you should always define the correct height and width for the meters or the window's dimensions might be calculated wrongly.

H
The height of the meter. This can also be left undefined under the same conditions as W.

Hidden
If set to 1, the meter is hidden.

LeftMouseDownAction
RightMouseDownAction
LeftMouseUpAction
RightMouseUpAction
MouseOverAction
MouseLeaveAction
These are the same as with the global settings except that they only apply to the specific meter. I.e. The mouse action is only executed when the mouse is on the meter's area. These settings override the global setting.

Note that the LeftMouseUpAction does not work if the window is draggable. You need to define the drag area with DragMargins so that it doesn't overlap with the meter.

UpdateDivider
This value determines how often the meter is updated. This is bound to the Update value. For example if the Update is set to 1000 and the UpdateDivider is 30, the meter is updated every 30 seconds. The default value is 1.

SolidColor
The color of the meter's background.

SolidColor2
The second color of the meter's background for gradient.

GradientAngle
The angle of the meter's background color gradient. The angle is defined as radians.

BevelType
This draws a bevel edge around the solid background. 0 = no bevel, 1 = raised, 2 = sunken.

Meter
Type of the meter. The valid values are:

  • HISTOGRAM
  • STRING
  • BAR
  • BITMAP
  • IMAGE
  • LINE
  • ROTATOR
  • BUTTON

Histogram

SecondaryMeasureName
The name of the secondary measure. This defines the measure for the secondary histogram that is drawn on the same meter. It is not necessary to define this if the other meter is not needed.

PrimaryColor
Color for the primary histogram. The colors are given in RGB format. Separate the color components with ",". E.g. PrimaryColor=10,30,255

SecondaryColor
Color for the secondary histogram.

BothColor
Color that is used when the primary and secondary histograms are on top of eachother.

PrimaryImage
Name of the image that is used behind the secondary histogram. You can only use either colors or images but not both at the same time. So, if you define PrimaryImage you must also define SecondaryImage and BothImage (if you have a secondary measure in the same histogram).

SecondaryImage
Name of the image that is used behind the secondary histogram.

BothImage
Name of the image that is used when the primary and secondary histograms are on top of eachother.

Autoscale
If set to 1, the histogram is automatically scaled to show all the values.

Flip
If set to 1 the meter is flipped upsidedown.


String

FontColor
The color of the text.

Prefix
String that is displayed before the value.

Postfix
String that is displayed after the value.

FontFace
Name of the font

FontSize
Size of the font.

StringAlign
The alignment of the string. The valid values are: LEFT, CENTER and RIGHT.

StringStyle
Style of the string. The valid values are: NORMAL, BOLD, ITALIC and BOLDITALIC.

Scale
Scaling factor for the measured value. The measured value is divided with the scale value, so in order to get 1000 times smaller values just set the scale to 1000. If the scale value has a decimal point (e.g. 1000.0) the resulting measured value is displayed as floating point value with one decimal.

AutoScale
If set to 1, the value is scaled automatically. This setting overrides Scale. The value is automatically postfixed with T, G, M or k depending how much it was scaled.

Percentual
If set to 1, the value is displayed in percents.

NumOfDecimals
The number of decimals used in the displayed value.

AntiAlias
If set to 1, the text is drawn as antialiased.

Text
The text that is displayed. Use %1 in the string to display the measured value. If this is bound to several measures just use %2, %3, etc. for different values.

ClipString
If set to 1 the width (W) of the meter clips the string. An ellipsis is added to the end of the string.

Angle
This defines the angle of the text. The value is given as radians. Note that the size of the text is still calculated as if the text would be horizontal.


Bar

BarColor
The color of the bar.

BarImage
The image that is used behind the bar. This can be used instead of the BarColor.

BarBorder
This defines how much from the beginning and end of the bitmap is always drawn.

BarOrientation
The orientation of the bar. Valid values are:

  • HORIZONTAL
  • VERTICAL

Flip
Set to 1 to flip the direction of the bar.


Bitmap

BitmapImage
This is the name of the image that holds the image frames. The images can be laid horizontally or vertically in the bitmap. The orientation is determined automatically form the hieght or the width of the bitmap (whichever is larger). Also the size of one frame is calculated automatically so you need to crop the image so that there is no extra space around the frames.

BitmapFrames
The number of  frames in the bitmap.

BitmapZeroFrame
If set to 1, the first frame is used only when the measured value is zero. Otherwise the frames are linearly determined by the measured value.

BitmapExtend
If set to 1 the bitmap is extended so display the whole value. For example if you define a bitmap that defines frames from 0 to 9 you can use this to display the measured value as the bitmap numbers. 

BitmapDigits
Number of digits that are drawn. The first frame is used if the value doesn't have as many digits as this defines. Works only when BitmapExtend is set to 1.

BitmapAlign
Defines the alignment of the bitmap value. Valid values are LEFT, CENTER and RIGHT. Works only when BitmapExtend is set to 1.


Image

Note that this meter need's not to be bound on any measure as it really doesn't show the measured value in any way. The purpose for this meter is to make skinning easier. However, if you bind this to something it tries to load the image that the measure gives out as string value. If the W and H are defined for the meter, the image is scaled to the given size.

ImageName
Name of the image to be displayed.


Line

LineCount
Number of lines in the meter. There can be any number of lines in the same meter. The below settings are set for the different lines by specifying the line number after the name. Note that the [N] for the first line is never given. So, for example to set the color of the first line you'd give "LineColor=255,0,0" and for the second line "LineColor2=0,0,0", etc.

MeasureName[N]
The name of the measure for the line [N].

LineColor[N]
The color of the line N.

Scale[N]
The scale of the line N. The measured value is multiplied with this.

AutoScale
If set to 1, the lines are automatically scaled so that the largest value is visible in the meter. If set to 0, the meter's scale is taken from the largest max value of the measures.

HorizontalLines
If set to 1 horizontal lines are drawn behind the histogram lines.

HorizontalLineColor
The color of the horizontal lines.

AntiAlias
If set to 1, the lines are drawn as antialiased.

LineWidth
Width of the line.

Flip
If set to 1 the meter is flipped upsidedown.


Roundline

LineWidth
This defines the width of the line (1.0 = one pixel).

LineLength
This defines the length of the line. The lenght is always measured from the center of rotation (no matter what the LineStart value is).

LineStart
This defines where the line start.

StartAngle
The start angle for the line. This is in radians and the zero angle is towards positive x-axis. Normal rotation direction is clockwise.

RotationAngle
The size of the rotation angle for the line. Use negative value for counter-clockwise rotation.

AntiAlias
If set to 1, the line is antialiased.

ValueRemainder
Use remainder instead of the actual measured value. This can be used to draw analog clock (check the example in the example skin files).

LineColor
The color of the line.

Solid
Set to 1 and the meter will draw a pie-chart instead.


Rotator

ImageName
Name of the image to be rotated

OffsetX
X-offset of the center of rotation.

OffsetY
Y-offset of the center of rotation.

StartAngle
The start angle for the line. This is in radians and the zero angle is towards positive x-axis. Normal rotation direction is clockwise.

RotationAngle
The size of the rotation angle for the line. Use negative value for counter-clockwise rotation.

ValueRemainder
Use remainder instead of the actual measured value. This can be used to draw analog clock (check the example in the example skin files).


Button

This not a normal meter since you cannot bind it to any measure. The purpose of it is to make button creation easier.

ButtonImage
The name of the button image. The image must have 3 frames which can be set either horizontally or vertically (The orientation is checked from the width/height of the image).

ButtonCommand
The command or !bang that is executed when the button is pressed.